/*
 * Copyright © 2017-2023 TemplateFactory(xiaoymin@foxmail.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.github.xiaoymin.template.factory;

import com.github.xiaoymin.template.core.TemplateContext;
import com.github.xiaoymin.template.render.TemplateFactoryRender;

import java.util.Map;

/***
 * 1、插件顶级接口,该插件提供给对外提供给开发者,开发者可以自己实现自己的模板生成规则.
 * 2、TemplateEngine会将目前的表名、Template解析参数等上下文参数传递给子插件,供开发者调用
 * @since template-engine 1.0
 * @author <a href="mailto:xiaoymin@foxmail.com">xiaoymin@foxmail.com</a> 
 * 2020/06/06 15:35
 */
public interface TemplateFactory {
    
    /**
     * 当前插件的别名
     * @return
     */
    String getAliasName();
    
    /**
     * 获取当前模板的Render实例
     * @return
     */
    Map<String, TemplateFactoryRender> getRenders();
    /**
     * 执行模板插件,输出目标文件
     * @param templateContext
     */
    void apply(TemplateContext templateContext);
}
